home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 52 / Amiga Format AFCD52 (Issue 136, May 2000).iso / -in_the_mag- / pdselect / ispell_yam / help / ispell_setup.txt next >
Text File  |  2000-03-08  |  17KB  |  380 lines
  1. Hello YAMmer's,
  2.  
  3. Here is my 2¢ worth on "How BEST to use iSpell_3.1.18p4 with YAM_2.0"...
  4.  
  5. I have successfully installed and used both AlphaSpell_6.2 and iSpell_3.1
  6. .18p4 with YAM_2.0
  7.  
  8. I initially used ASpell but switched to iSpell because it is more versatile.
  9.  
  10. This is what you need to do to get iSpell functioning properly with YAM_2.0
  11.  
  12.   ************************************************************************
  13.   ***                                                                  ***
  14.   ***       The current iSpell_ .rexx scripts and HELP include:        ***
  15.   ***                                                                  ***
  16.   ***       1. iSpell_all.rexx       v1.97  (Brecht, Lorens, Ben)      ***
  17.   ***       2. iSpell_exit.rexx      v1.0   (Brecht)                   ***
  18.   ***       3. iSpell_lookup.rexx    v1.3   (Brecht, Markus)           ***
  19.   ***       4. iSpell_suggest.rexx   v1.2   (Brecht, Markus)           ***
  20.   ***       5. iSpell_lang.rexx      v0.4   (Brecht)                   ***
  21.   ***       6. iSpell_mr.rexx (GUI)  v0.4   (Brecht and Lorens)        ***
  22.   ***                                                                  ***
  23.   ***       iSpell_Setup.TXT         v1.08  (Mike Hendren)             ***
  24.   ***                                                                  ***
  25.   ************************************************************************
  26.  
  27. Steps:
  28. ------
  29.  
  30. 1. D/L Aminet util/gnu ispell31p4bin.lha 660k (Do NOT use any other version!)
  31.    D/L Aminet util/libs ixemul-48.0.lha 598k (Required by iSpell Rexx Server)
  32.    D/L Aminet dev/mui MUIRexx_3.0a.lha 336k (Required by iSpell_mr.rexx)
  33.  
  34. 2. Install iSpell_3.1.18p4 as follows:
  35.    After decompressing the .lha, rename the "ispell-3.1.18bin" directory to
  36.    "iSpell", then copy it to where ever you want it to reside...  Ensure
  37.    that the "iSpell" sub-directories "bin" and "lib" and their contents are
  38.    retained inside the "iSpell" directory so that the attached iSpell_ .rexx
  39.    scripts can locate the iSpell Rexx Server and the iSpell dictionaries as
  40.    needed...
  41.  
  42.    Copy (For your CPU!) ixemul.library and ixnet.library to LIBS:
  43.  
  44.    Install MUIRexx_3.0a
  45.    (MUIRexx MUST be in your Search Path; e.g. C: or SYS:MUI)
  46.    (MUIRexx Should be Assigned e.g. Assign MUIRexx: SYS:MUI)
  47.  
  48. 3. Ensure that iSpell is assigned in your S:User-Startup or some other
  49.    location for your assigns!  e.g. Assign iSpell: SYS:Read-Edit/iSpell
  50.  
  51. 4. Copy these attached MUI iSpell_ .rexx scripts to:
  52.    iSpell_suggest.rexx  to MUI:Rexx
  53.    iSpell_lookup.rexx   to MUI:Rexx
  54.  
  55.    *** and ***
  56.  
  57.    You can control most aspects of MUI from the preferences program
  58.    SYS:Prefs/MUI or MUI:MUI (depending on your installation).
  59.  
  60.    This is also where you configure the internal editor used in YAM.
  61.    This editor is the MUI MCC_TextEditor class written by Allan Odgaard.
  62.    It is simply an extension of MUI.  With MUI you have the choice of
  63.    using the global settings (recommended for MCC_TextEditor class) or
  64.    configuring YAM locally, which will override the global settings.
  65.  
  66.    (I have attached (1) .PNG image to help with these steps)
  67.  
  68.    After starting the MUI preferences program (either global, or local for
  69.    YAM) select the "TextEditor" item in the listview. A new page appears
  70.    with 4 subpages, select the one titled "Spell checker" and configure it
  71.    as follows:
  72.  
  73.                   Lookup command: [ARexx] MUI:Rexx/iSpell_lookup.rexx %s
  74.                  Suggest command: [ARexx] MUI:Rexx/iSpell_suggest.rexx %s
  75.  
  76.                            Spell check as you type? = Checked (Recommended)
  77.                      Lookup word before suggesting? = Checked (Recommended)
  78.  
  79.    NOTE: If you configure the above globally, and it doesn't work for YAM
  80.    then it's likely that you have a different local config for YAM. Simply
  81.    start MUI prefs from YAMs preference menu, and select the TextEditor page,
  82.    now choose "Reset to global" (from the context menu).
  83.    This should synchronize YAMs local config with the global one.  Please
  84.    refer to the MUI documentation for more details concerning this subject.
  85.  
  86. 5. Copy these attached YAM iSpell_ .rexx scripts to:
  87.    iSpell_mr.rexx (GUI) to YAM:Rexx
  88.    iSpell_all.rexx      to YAM:Rexx
  89.    iSpell_exit.rexx     to YAM:Rexx
  90.    iSpell_lang.rexx     to YAM:Rexx
  91.  
  92.    *** and ***
  93.  
  94.    (I have attached (5) .PNG images to help with these steps)
  95.  
  96.    Set up (1) of your YAM Config/ARexx 'Scripts' menu entries (0-9) to use:
  97.    YAM:Rexx [AmigaDOS] MUIRexx YAM:Rexx/iSpell_mr.rexx port ISPELLMR
  98.                                      (Do Not select "Open console window")
  99.                                      (Do Not select "Wait for termination")
  100.  
  101.    Set up (1) of your YAM Config/ARexx 'Scripts' menu entries (0-9) to use:
  102.    YAM:Rexx [ARexx] iSpell_all.rexx  (Do Not select "Open console window")
  103.                                      (Do Not select "Wait for termination")
  104.  
  105.    Set up (1) of your YAM Config/ARexx 'Scripts' menu entries (0-9) to use:
  106.    YAM:Rexx [ARexx] iSpell_exit.rexx (Do Not select "Open console window")
  107.                                      (Select "Wait for termination")
  108.  
  109.    Set up (1) of your YAM Config/ARexx 'Scripts' menu entries (0-9) to use:
  110.    YAM:Rexx [ARexx] iSpell_lang.rexx  (Do Not select "Open console window")
  111.                                       (Do Not select "Wait for termination")
  112.  
  113.    ** and / or ** You can use the YAM ARexx Scripts 'Execute script' to
  114.                   select most of these YAM iSpell_ .rexx scripts when needed!
  115.  
  116.    *** and ***
  117.  
  118.    Set up YAM Config/ARexx 'Program Termination' to use:
  119.    YAM:Rexx [ARexx] iSpell_exit.rexx  (Do Not select "Open console window")
  120.                                       (Select "Wait for termination")
  121.             (This quits the iSpell Rexx Server when YAM is quit.)
  122.  
  123.  
  124. With this setup:
  125. ----------------
  126.  
  127. 1. When you type a word that the iSpell:lib/dictionaries do not recognize
  128.    you will get a System Alert (per your SYS:Prefs/Sound preferences).
  129.  
  130. 2. You can SELECT (Double Click) a word and press 'Command Help' and a list
  131.    of suggestions will pop up and you can select the appropriate one.
  132.  
  133. 3. You can Spell check ALL text by selecting the iSpell_mr.rexx (GUI) script
  134.    you included in step 5.  (This is more powerful than iSpell_all.rexx)
  135.  
  136.    You can Spell check ALL text by selecting the iSpell_all.rexx script you
  137.    included in step 5.
  138.  
  139. 4. You can QUIT the iSpell Rexx Server anytime by selecting the
  140.    iSpell_exit.rexx script you included in step 5.
  141.  
  142. 5. You can SAVE which Language you wish to use as the DEFAULT and
  143.    conveniently SELECT the Language you wish to use anytime with
  144.    the iSpell_lang.rexx script you included in step 5.
  145.  
  146.  
  147. iSpell_ .rexx scripts purpose:
  148. ------------------------------
  149. The ispell_ .rexx scripts which utilize the iSpell Rexx Server can ONLY
  150. be utilized from the: YAM TextEditor Write message window
  151.  iSpell_mr.rexx (GUI)
  152.  iSpell_all.rexx
  153.  iSpell_lookup.rexx
  154.  iSpell_suggest.rexx
  155.  
  156. Each script will check to see IF the iSpell Rexx Server is loaded...
  157. If NOT, then that script will load the iSpell Rexx Server and the DEFAULT
  158. Language (Main & User Dictionaries)...  If ENVARC:ISPELLYAM does NOT exist,
  159. the iSpell_lang.rexx script will be executed for a langugage selection...
  160.  
  161. If already loaded, then that script will NOT reload the iSpell Rexx Server...
  162. This is to prevent the iSpell Rexx Server from being loaded more than once...
  163.  
  164. YAM ARexx 'Program startup' is NOT needed to load the iSpell Rexx Server
  165. since it is automatically accomplished by these iSpell_ .rexx scripts...
  166. If you are NOT Writing, Replying or Forwarding messages, there is no need
  167. to load the iSpell Rexx Server...
  168.  
  169.  
  170. 1. iSpell_mr.rexx (GUI) is for spell checking ALL text.
  171.    (This is a GUI equivilant for iSpell_all.rexx and is more powerful)
  172.    iSpell_mr.rexx can be used to conveniently ADD words to the iSpell:lib/
  173.    .ispell_xxxx (User Dictionary)
  174.  
  175. 2. iSpell_all.rexx is for spell checking ALL text.
  176.    iSpell_all.rexx can be used to conveniently ADD words to the iSpell:lib/
  177.    .ispell_xxxx (User Dictionary)
  178.  
  179. 3. iSpell_lookup.rexx is for spell checking EACH word (Spell-As-You-Type).
  180.    This .rexx script identifies words that are NOT recognized in the iSpell:
  181.    lib/Main or User dictionary...  It does NOT suggest replacement words...
  182.    If you do NOT want to use this feature, CHANGE this setup to:
  183.    MUI Preferences | TextEditor | Spell checker:
  184.                           Spell check as you type? = UnChecked
  185.  
  186. 4. iSpell_suggest.rexx is for spell checking a SELECTED word using 'Command
  187.    Help' or some other keybinding of your choice.  This is very useful
  188.    when you only want to spell check words you are unsure of...
  189.    'Command Help' is the DEFAULT keybinding for MUI TextEditor.mcc V15.6
  190.    (I have attached (1) .PNG image to illustrate this DEFAULT keybinding)
  191.  
  192.  A. If the word is recognized, you will get the message "Word is correct".
  193.     This indicates that iSpell found a word spelled exactly the same way
  194.     in the iSpell:lib/Main or User dictionary...
  195.  
  196.  B. If the word is NOT recognized, you will get a list of suggestions with
  197.     words to select from unless iSpell does not have a suggestion in which
  198.     case you will get the message "No suggestions".  This indicates that
  199.     iSpell could NOT find any word spelled exactly the same way in the
  200.     iSpell:lib/Main or User dictionary...
  201.  
  202.  C. The "Esc" key is used to CLOSE the suggestion window if a replacement
  203.     word is not found or selected...
  204.  
  205. 5. iSpell_exit.rexx is to QUIT the iSpell Rexx Server.
  206.  
  207. 6. iSpell_lang.rexx is used to SELECT and SAVE the DEFAULT language to use
  208.    for the Main and User Dictionaries...  It is also used to conveniently
  209.    SELECT any language you wish to USE for the Main and User Dictionaries...
  210.    Currently, only (1) language can be selected and used by the iSpell Rexx
  211.    Server, however you can change languages and spell check again...
  212.    If you change languages, the iSpell Rexx Server will QUIT and subsequently
  213.    be loaded again with the new language you have selected...
  214.  
  215.  
  216. Dictionary Notes:
  217. -----------------
  218.          You MUST keep the language(s) of your choice in iSpell:lib/
  219.          e.g. iSpell:lib/english.hash      (Main Dictionary)
  220.                         /.ispell_English   (User Dictionary)
  221.  
  222.          e.g. iSpell:lib/nederlands.hash      (Main Dictionary)
  223.                         /.ispell_Nederlands   (User Dictionary)
  224.  
  225.          .ispell_xxx (User Dictionary) must ONLY contain words that are
  226.          in Lower CASE...   All of the iSpell_ .rexx scripts that utilize
  227.          the dictionaries will ACCEPT words that are in Upper, Lower or
  228.          Mixed CASE from the YAM TextEditor Write message window, unless
  229.          a word MUST be Capitalized per proper spelling rules...  These
  230.          words should be identified by the xxx.hash (Main Dictionary)
  231.  
  232.          iSpell_mr.rexx (GUI) and iSpell_all.rexx will always ADD words to
  233.          the .ispell_xxx (User Dictionary) in Lower CASE...
  234.  
  235.          If you ADD words to the .ispell_xxx (User Dictionary) using a
  236.          Text Editor, enter them in Lower CASE...
  237.  
  238.          If you already have an .ispell_xxx (User Dictionary) with Upper
  239.          and or Mixed CASE words, use a Text Editor to change them ALL to
  240.          Lower CASE, which will allow them to be recognized by iSpell...
  241.  
  242.          If the .ispell_xxx (User Dictinary) does NOT exist, it will be
  243.          created the first time you use iSpell_mr (GUI) or iSpell_all.rexx
  244.          to ADD a word...
  245.  
  246.          Only the English "english.hash" (Main Dictionary) is included with
  247.          the Aminet util/gnu ispell31p4bin.lha distribution...   If you use
  248.          other language(s), you will need to obtain and install them to:
  249.          iSpell:lib/xxx.hash
  250.  
  251.          Dictionaries are available for: Dansk, Deutsch, English, Espanol,
  252.          Francais, Nederlands, Norsk, Italian, Russian, Svenska etc.
  253.  
  254.          iSpell Dictionaries can be downloaded from:
  255.          http://fmg-www.cs.ucla.edu/geoff/ispell-dictionaries.html
  256.  
  257.          These iSpell UN*X dictionaries may need to be rebuilt for the Amiga
  258.  
  259.          Aminet util/gnu ispell31p4src.lha - Contains all needed sources for
  260.          rebuilding dictionaries.
  261.  
  262.  
  263. Notes:
  264. ------
  265. I have attached (6) .PNG images to help you with the Setup instructions for
  266. Steps: 4 & 5...   PNG was used to keep the image file size to a minimum...
  267. If you are unable to use SYS:Classes/DataTypes/png.datatype, let me know and
  268. I will send you these images as Amiga IFF (ILBM) so that you can view them...
  269.  
  270. MUI | TextEditor | Keybindings DEFAULT is 'Command Help = Suggest spelling'
  271. So, either 'Amiga' key and the 'Help' key will activate "iSpell_Suggest.rexx"
  272. (I have attached (1) .PNG image to illustrate this DEFAULT keybinding)
  273. You can change this...  I use 'RShift Help' instead, it's easier to reach...
  274.  
  275. Some special characters cause problems for iSpell e.g. (-) Hyphen and probably
  276. some others that we have yet to discover...  (Brecht is still working on this)
  277.  
  278. The iSpell Rexx Server may cause your Virus checker program to display an
  279. ALERT (Memory Vectors) since it is loaded into RAM: (Background CLI process)
  280.  
  281. The iSpell Rexx Server uses about 500k of memory when loaded...
  282. The iSpell:lib/xxx.hash (Main Dictionary) and .ispell_xxx (User Dictionary)
  283. also use memory equal to their applicable file size when loaded by the
  284. iSpell Rexx Server...   Check to see that you have enough memory available to
  285. use iSpell with YOUR Language dictionaries before you install this setup...
  286.  
  287.  
  288. Troubleshooting:
  289. ----------------
  290. If you were previously using AlphaSpell, ensure that you recheck ALL of the
  291. SYS: MUI | MUI Preferences | TextEditor | Spell checker settings and the
  292. SYS: YAM | MUI Preferences | TextEditor | Spell checker settings as well as
  293. the YAM ARexx 'Scripts' menus etc. for proper scripts, paths and actions...
  294.  
  295. AlphaSpell uses AmigaDOS scripts as the Spell and StopSpell scripts...
  296. This requires MUI Preferences | TextEditor | Spell checker Lookup and Suggest
  297. commands to be QUOTED " " & YAM ARexx 'Scripts' menu entries to be [AmigaDOS]
  298.  
  299. iSpell uses ARexx scripts for most of the iSpell_ .rexx scripts...
  300. This requires MUI Preferences | TextEditor | Spell checker Lookup and Suggest
  301. commands to be UnQUOTED & YAM ARexx 'Scripts' menu entries to be [ARexx]
  302.  
  303. Make sure that your iSpell:lib/.ispell_xxx (User Dictionary) if one exist
  304. is not corrupted, and ALL words are in Lower CASE...
  305.  
  306. Check if your MUI Preferences | TextEditor | Keybindings 'Suggest spelling'
  307. is being used by another ACTIVE Amiga program which could create a conflict?
  308.  
  309. Check SYS: MUI | MUI Preferences | TextEditor settings
  310.           *** vs ***
  311.       SYS: YAM | MUI Preferences | TextEditor settings
  312. for a conflict in the Spell checker and Keybindings sections...
  313.  
  314. Maybe you are using some patch or hack that is interfering?
  315.  
  316. DO NOT USE: iSpell_3.3ljr or iSpell_3.1.20  They do NOT work with this setup!
  317.  
  318.  
  319. Programmers:
  320. ------------
  321. There are (4) YAM ARexx programmers (that I'm aware of) who collectively,
  322. have been able to get iSpell and YAM functioning properly...
  323.  
  324. 1. Brecht Machiels <darklite@beer.com>
  325. 2. Lorens Johansson <SnorsleX@Home.se>
  326. 3. Roger "Ben" Bennett <bennett@net.ntl.com>
  327. 4. Markus Maier <mkm@gmx.de>
  328.  
  329.  
  330. Thanks To:
  331. ----------
  332. 1. Marcel Beck (YAM_2.0)
  333. 2. Jesper Skov (iSpell_3.1.18p4)
  334. 3. Brecht, Lorens, Ben and Markus (ARexx programming of iSpell .rexx scripts)
  335. 4. Allan Odgaard (MUI MCC_TextEditor etc.)
  336.  
  337.  
  338. Special Thanks To:
  339. ------------------
  340. Brecht, who has continued to improve ALL of the iSpell_ .rexx scripts and
  341. refined them to there current excellent cooperation with iSpell and YAM...
  342.  
  343. Allan, who has donated http://www.DIKU.dk/students/duff/TextEditor/index.html
  344. for you to download these iSpell_ .rexx scripts and iSpell_Help files...
  345. While you are there, verify you are using his latest MCC_TextEditor version...
  346.  
  347. Lorens, who has established a ML for Amiga iSpell_YAM users...
  348.  It is intended to help each other using iSpell_YAM...
  349.  It is located at ONElist...
  350.  
  351.        Community email addresses:
  352.         Post message: AmigaISpell@onelist.com
  353.         Subscribe   : AmigaISpell-subscribe@onelist.com
  354.         Unsubscribe : AmigaISpell-unsubscribe@onelist.com
  355.         List owner  : AmigaISpell-owner@onelist.com
  356.  
  357.  
  358. The End:
  359. --------
  360. I hope this helps you get iSpell and YAM functioning...   I LIKE IT!
  361. iSpell is very useful and I find it saves much time and embarrassment...
  362.  
  363.  
  364.  
  365. Enjoy,
  366. Mike
  367. --
  368.  
  369.   Mike Hendren              C64 - C128 - Amiga
  370.  
  371.              Commodore Connection
  372.  
  373.       Hardware/Software  Repair/Service
  374.  
  375.                E-mail: mmikee@cts.com
  376.            Snail-mail: 1118 Old Stage Road
  377.                        Fallbrook, CA 92028
  378.                 Phone: (760) 728-6304
  379.                  ICQ : 48881110
  380.